KTweenHandle

A KTweenHandle is returned by KTween:Create. It controls a single tween: start it with :Play(), stop it with :Cancel(), and listen for completion with the Finished event. You cannot create a KTweenHandle directly.

Not newable

This object cannot be created by scripts using Instance.New().

Properties

IsRunning : boolean

True while the tween is actively playing.

Methods

Play → KTweenHandle

Parameters: ``

Starts (or restarts) the tween. Returns the handle so calls can be chained.

Cancel → nil

Parameters: ``

Stops the tween immediately and fires the Canceled event.

Events

Finished

Parameters: ``

Fires when the tween finishes playing all of its loops.

Canceled

Parameters: ``

Fires when the tween is stopped early via Cancel.